Autogenerated HTML docs for v1.6.6-rc4
diff --git a/technical/api-hash.html b/technical/api-hash.html index e2e4395..b43a7ef 100644 --- a/technical/api-hash.html +++ b/technical/api-hash.html
@@ -311,13 +311,92 @@ </div> <div id="preamble"> <div class="sectionbody"> -<div class="para"><p>Talk about <hash.h></p></div> -<div class="para"><p>(Linus)</p></div> +<div class="para"><p>The hash API is a collection of simple hash table functions. Users are expected +to implement their own hashing.</p></div> </div> </div> +<h2 id="_data_structures">Data Structures</h2> +<div class="sectionbody"> +<div class="vlist"><dl> +<dt> +<tt>struct hash_table</tt> +</dt> +<dd> +<p> + The hash table structure. The <tt>array</tt> member points to the hash table + entries. The <tt>size</tt> member counts the total number of valid and invalid + entries in the table. The <tt>nr</tt> member keeps track of the number of + valid entries. +</p> +</dd> +<dt> +<tt>struct hash_table_entry</tt> +</dt> +<dd> +<p> + An opaque structure representing an entry in the hash table. The <tt>hash</tt> + member is the entry's hash key and the <tt>ptr</tt> member is the entry's + value. +</p> +</dd> +</dl></div> +</div> +<h2 id="_functions">Functions</h2> +<div class="sectionbody"> +<div class="vlist"><dl> +<dt> +<tt>init_hash</tt> +</dt> +<dd> +<p> + Initialize the hash table. +</p> +</dd> +<dt> +<tt>free_hash</tt> +</dt> +<dd> +<p> + Release memory associated with the hash table. +</p> +</dd> +<dt> +<tt>insert_hash</tt> +</dt> +<dd> +<p> + Insert a pointer into the hash table. If an entry with that hash + already exists, a pointer to the existing entry's value is returned. + Otherwise NULL is returned. This allows callers to implement + chaining, etc. +</p> +</dd> +<dt> +<tt>lookup_hash</tt> +</dt> +<dd> +<p> + Lookup an entry in the hash table. If an entry with that hash exists + the entry's value is returned. Otherwise NULL is returned. +</p> +</dd> +<dt> +<tt>for_each_hash</tt> +</dt> +<dd> +<p> + Call a function for each entry in the hash table. The function is + expected to take the entry's value as its only argument and return an + int. If the function returns a negative int the loop is aborted + immediately. Otherwise, the return value is accumulated and the sum + returned upon completion of the loop. +</p> +</dd> +</dl></div> +</div> <div id="footer"> <div id="footer-text"> -Last updated 2009-12-03 09:13:00 UTC +Last updated 2009-12-20 23:01:20 UTC </div> </div> </body>